Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Aug 12, 2025

Link issues

fixes #6606

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Improve SSR performance by migrating FooterCounter timer logic to a client-side JavaScript module, refactoring the component lifecycle, and making related UI and style adjustments

Enhancements:

  • Offload FooterCounter runtime updates to a dedicated JavaScript module and remove server-driven timer loops
  • Refactor FooterCounter to use JSModuleAutoLoader and override InvokeInitAsync and DisposeAsync
  • Adjust Dashboard tutorial Scroll spacing, introduce .progress-item wrapper, and add corresponding CSS
  • Update Video component markup to simplify icon rendering and use Count property for conditional checks
  • Add border-radius inheritance in Index page CSS for consistent styling

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Aug 12, 2025
@bb-auto bb-auto bot added this to the 9.9.0 milestone Aug 12, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Aug 12, 2025

Reviewer's Guide

This PR refactors the FooterCounter component to offload runtime updates to a dedicated JavaScript module for SSR performance, replaces C#-based timers with JS interop via JSModuleAutoLoader, and includes related style and markup optimizations in sample dashboards, video links, and page CSS.

Sequence diagram for FooterCounter runtime update via JS interop

sequenceDiagram
    participant Blazor as Blazor Component (FooterCounter)
    participant JS as JavaScript Module (FooterCounter.razor.js)
    Blazor->>JS: init(id, totalSeconds) on first render
    JS->>JS: Start setInterval(tick, 1000)
    JS->>Blazor: (no direct callback, JS updates DOM)
    loop Every 30 seconds
        Blazor->>JS: updateFooterCounter(id, totalSeconds)
        JS->>JS: Update totalSeconds in Data
    end
    Blazor->>JS: dispose(id) on component dispose
    JS->>JS: clearInterval(handler), remove Data
Loading

Class diagram for updated FooterCounter component

classDiagram
    class FooterCounter {
        - string? Runtime
        - readonly CancellationTokenSource _disposeTokenSource
        - ConnectionHubOptions _options
        + OnInitialized()
        + OnAfterRenderAsync(bool firstRender)
        + InvokeInitAsync()
        + DisposeAsync(bool disposing)
    }
    FooterCounter --|> WebSiteModuleComponentBase
Loading

File-Level Changes

Change Details Files
FooterCounter component refactored for JS-driven updates and SSR optimization
  • Removed IDisposable pattern and replaced with async DisposeAsync override
  • Inherited WebSiteModuleComponentBase and added JSModuleAutoLoader attribute
  • Replaced C# OnAfterRenderAsync timer loop with JS init/update via InvokeVoidAsync
  • Introduced InvokeInitAsync override for initial JS module setup
  • Adjusted markup to include element Id and fixed width for JS targeting
  • Added FooterCounter.razor.js to manage interval tick, update, and cleanup
FooterCounter.razor.cs
FooterCounter.razor
FooterCounter.razor.js
Dashboard tutorial sample markup and styling simplified
  • Replaced manual scroll container margin with unified padding/margin styles
  • Wrapped each progress entry in a .progress-item div
  • Added .progress-item spacing rule in Dashboard.razor.css
Tutorials/Dashboard.razor
Tutorials/Dashboard.razor.css
Video component icon markup and condition check refined
  • Changed VideoUrl.Any() to Count > 0 for enumeration check
  • Moved font-awesome class to an tag inside the anchor
Video.razor
General CSS adjustment
  • Added border-radius: inherit to a positioned element in Index.razor.css
Pages/Index.razor.css

Assessment against linked issues

Issue Objective Addressed Explanation
#6606 Improve the performance of the FooterCounter component in SSR (Server-Side Rendering) mode.
#6606 Update documentation to reflect the performance improvements for FooterCounter in SSR mode.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@ArgoZhang ArgoZhang merged commit 948a9b9 into main Aug 12, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the refactor-home branch August 12, 2025 01:29
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Blocking issues:

  • User controlled data in methods like innerHTML, outerHTML or document.write is an anti-pattern that can lead to XSS vulnerabilities (link)
  • User controlled data in a el.innerHTML is an anti-pattern that can lead to XSS vulnerabilities (link)

General comments:

  • The DisposeAsync override signature (protected override ValueTask DisposeAsync(bool disposing)) won’t be called by the Blazor runtime—override DisposeAsync() without parameters and invoke your JS module’s dispose(id) to clear the client‐side interval.
  • Swapping VideoUrl.Any() for VideoUrl.Count > 0 may force full enumeration on IEnumerable; consider reverting to .Any() for a more efficient existence check.
  • Silently catching all exceptions in OnAfterRenderAsync can hide issues—at minimum log or handle unexpected errors instead of swallowing them.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The DisposeAsync override signature (protected override ValueTask DisposeAsync(bool disposing)) won’t be called by the Blazor runtime—override DisposeAsync() without parameters and invoke your JS module’s dispose(id) to clear the client‐side interval.
- Swapping VideoUrl.Any() for VideoUrl.Count > 0 may force full enumeration on IEnumerable; consider reverting to .Any() for a more efficient existence check.
- Silently catching all exceptions in OnAfterRenderAsync can hide issues—at minimum log or handle unexpected errors instead of swallowing them.

## Individual Comments

### Comment 1
<location> `src/BootstrapBlazor.Server/Components/Components/FooterCounter.razor.js:13` </location>
<code_context>
+        const counter = Data.get(id);
+
+        counter.totalSeconds = (counter.totalSeconds || 0) + 1;
+        const now = Math.round(counter.totalSeconds, 0);
+
+        const days = Math.floor(now / (24 * 3600));
</code_context>

<issue_to_address>
Math.round does not accept a second argument.

Remove the second argument from Math.round, as it is ignored. If you need to round to a specific decimal place, consider using a different method.
</issue_to_address>

## Security Issues

### Issue 1
<location> `src/BootstrapBlazor.Server/Components/Components/FooterCounter.razor.js:21` </location>

<issue_to_address>
**security (javascript.browser.security.insecure-document-method):** User controlled data in methods like `innerHTML`, `outerHTML` or `document.write` is an anti-pattern that can lead to XSS vulnerabilities

*Source: opengrep*
</issue_to_address>

### Issue 2
<location> `src/BootstrapBlazor.Server/Components/Components/FooterCounter.razor.js:21` </location>

<issue_to_address>
**security (javascript.browser.security.insecure-innerhtml):** User controlled data in a `el.innerHTML` is an anti-pattern that can lead to XSS vulnerabilities

*Source: opengrep*
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

const counter = Data.get(id);

counter.totalSeconds = (counter.totalSeconds || 0) + 1;
const now = Math.round(counter.totalSeconds, 0);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: Math.round does not accept a second argument.

Remove the second argument from Math.round, as it is ignored. If you need to round to a specific decimal place, consider using a different method.

const seconds = now % 60;

const pad = num => num.toString().padStart(2, '0');
el.innerHTML = `Run ${pad(days)}.${pad(hours)}:${pad(minutes)}:${pad(seconds)}`;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

security (javascript.browser.security.insecure-document-method): User controlled data in methods like innerHTML, outerHTML or document.write is an anti-pattern that can lead to XSS vulnerabilities

Source: opengrep

const seconds = now % 60;

const pad = num => num.toString().padStart(2, '0');
el.innerHTML = `Run ${pad(days)}.${pad(hours)}:${pad(minutes)}:${pad(seconds)}`;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

security (javascript.browser.security.insecure-innerhtml): User controlled data in a el.innerHTML is an anti-pattern that can lead to XSS vulnerabilities

Source: opengrep

@codecov
Copy link

codecov bot commented Aug 12, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (6086ac3) to head (d72359d).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6607   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          739       739           
  Lines        31669     31669           
  Branches      4458      4458           
=========================================
  Hits         31669     31669           
Flag Coverage Δ
BB 100.00% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc(FooterCounter): improve performance for ssr mode

2 participants